API Documentation
Public Member Functions | List of all members
nkGraphics::SubEntity Class Referencefinal

Holds information about a sub entity, a renderable exposing the geometry. More...

Inheritance diagram for nkGraphics::SubEntity:
nkExport::Exportable

Public Member Functions

 SubEntity ()
 
 ~SubEntity ()
 
EntitygetParentEntity () const
 
MeshgetMesh () const
 
BoundingBoxgetBounds () const
 
void setParentEntity (Entity *ent)
 
void setMesh (Mesh *mesh)
 
void setDirtyNodeTransform (bool value)
 
void meshUpdatedBounds ()
 
void meshUpdatedLayout ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

Holds information about a sub entity, a renderable exposing the geometry.

Constructor & Destructor Documentation

◆ SubEntity()

nkGraphics::SubEntity::SubEntity ( )

Constructor.

◆ ~SubEntity()

nkGraphics::SubEntity::~SubEntity ( )

Destructor.

Member Function Documentation

◆ getParentEntity()

Entity* nkGraphics::SubEntity::getParentEntity ( ) const
Returns
The parent entity.

◆ getMesh()

Mesh* nkGraphics::SubEntity::getMesh ( ) const
Returns
The mesh attached.

◆ getBounds()

BoundingBox* nkGraphics::SubEntity::getBounds ( ) const
Returns
The current bounds.

◆ setParentEntity()

void nkGraphics::SubEntity::setParentEntity ( Entity ent)

Sets the parent entity.

Parameters
entThe entity to set.

◆ setMesh()

void nkGraphics::SubEntity::setMesh ( Mesh mesh)

Sets the mesh attached to the sub entity.

Parameters
meshThe mesh to use.

◆ setDirtyNodeTransform()

void nkGraphics::SubEntity::setDirtyNodeTransform ( bool  value)

Sets whether the node transform is dirty or not. This will trigger bounds re-computation.

Parameters
valueWhether the transform is dirty (true) or not (false).

◆ meshUpdatedBounds()

void nkGraphics::SubEntity::meshUpdatedBounds ( )

Updates the bounds when a mesh is changed. Used internally.

◆ meshUpdatedLayout()

void nkGraphics::SubEntity::meshUpdatedLayout ( )

Updates the layout when a mesh is changed. Used internally.

◆ exportClassToTree()

virtual void nkGraphics::SubEntity::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Implements nkExport::Exportable.

◆ importClassFromTree()

virtual void nkGraphics::SubEntity::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Implements nkExport::Exportable.


The documentation for this class was generated from the following file: